/*
===========================================================================
This source file is part of DyLab (Dynamic Laboratory)
For the latest info, see http://dylab.googlecode.com

Copyright (c) 2006-2008 Lukas Krejci
(krejci.lukas@volny.cz)

This file is part of DyLab.

    DyLab is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DyLab is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DyLab.  If not, see <http://www.gnu.org/licenses/>.
===========================================================================
*/

#ifndef __dylab_EnumIterator_h__
#define __dylab_EnumIterator_h__

//===========================================================================================
#include <dylab/utils/exceptions/EAssertionFailed.h>

//===========================================================================================
namespace dylab {

    /** 
     */    
    template < 
        typename EnumT,
        EnumT FirstV,
        EnumT LastV,
        uint32_t StepV = 1
    >
    class EnumIterator
    {
    private:
        ///
        uint32_t mOrderValue;
    public:
        /**
        */
        EnumIterator(EnumT orderValue = FirstV) 
            : mOrderValue(orderValue)
                { }

        /**
        */
        bool isValid() 
                { return mOrderValue <= LastV; }

        /**
        */
        EnumIterator & operator++ () 
                { 
                    mOrderValue += StepV; 
                    return *this; 
                }

        /**
        */
        EnumIterator & operator++ (int) 
                { 
                    mOrderValue += StepV; 
                    return *this; 
                }

        /**
        */
        EnumT operator *() 
                { 
                    DYLAB_ASSERT(isValid()); 
                    return EnumT(mOrderValue); 
                }

        /**
        */
        operator EnumT () 
                { 
                    DYLAB_ASSERT(isValid()); 
                    return EnumT(mOrderValue); 
                }
    };
}

//===========================================================================================
#endif // __dylab_EnumIterator_h__
